fix: Storybook 上で props のドキュメントが表示されない問題を修正 #4719
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
s-sasaki-0529
commented
Jun 13, 2024
| @@ -64,6 +64,9 @@ const config: StorybookConfig = { | |||
| docs: { | |||
| autodocs: true, | |||
| }, | |||
| typescript: { | |||
| reactDocgen: 'react-docgen-typescript', | |||
| }, | |||
There was a problem hiding this comment.
コンポーネントファイルの静的解析を行ってるツールが、Storybook v7 までは react-docgen-typescript だったんですが、v8 からはデフォルトが react-docgen に代わりました。
react-docgen の強みはパフォーマンスなんですが、機能面ではわずかに react-docgen-typescript に負けます。
基本的には react-docgen でことたりるんですが、どうやら smarthr-ui の Storybook の使い方だと、 react-docgen-typescript を使わないと情報が取得できなかったみたいです。なので使用するツールを明示して復活させます。
このあたりについては、急に手前味噌記事を出しますが、以下記事で深堀りしてます。
Storybook と react-docgen の仕組みを追う
s-sasaki-0529
requested review from
yt-ymmt and
moshisora
and removed request for
a team
uknmr
approved these changes
Jun 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related URL
https://smarthr.atlassian.net/browse/SHRUI-989
Overview
Storybook v8 にマイグレーションしたタイミングから、Storybook 上で props のドキュメンテーションが表示されなくなっていたので復活させる
What I did
コンポーネントの静的解析に
react-docgenでなくreact-docgen-typescriptを使用するように明示するCapture